'\" t
.\"     Title: \fBndb_mgmd\fR
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 11/04/2009
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.1
.\"  Language: English
.\"
.TH "\FBNDB_MGMD\FR" "8" "11/04/2009" "MySQL 5\&.1" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" ndb_mgmd (MySQL Cluster process)
.\" MySQL Cluster: ndb_mgmd process
.\" MySQL Cluster: management nodes
.\" management nodes (MySQL Cluster)
.\" ndb_mgmd
.SH "NAME"
ndb_mgmd \- the MySQL Cluster management server daemon
.SH "SYNOPSIS"
.HP \w'\fBndb_mgmd\ \fR\fB\fIoptions\fR\fR\ 'u
\fBndb_mgmd \fR\fB\fIoptions\fR\fR
.SH "DESCRIPTION"
.PP
The management server is the process that reads the cluster configuration file and distributes this information to all nodes in the cluster that request it\&. It also maintains a log of cluster activities\&. Management clients can connect to the management server and check the cluster\'s status\&.
.\" MySQL Cluster: administration
.\" MySQL Cluster: commands
.\" command options (MySQL Cluster): ndb_mgmd
.\" MySQL Cluster: mgmd process
.PP
The following table includes options that are specific to the MySQL Cluster management server program
\fBndb_mgmd\fR\&. Additional descriptions follow the table\&. For options common to all MySQL Cluster programs, see
Section\ \&17.4.2, \(lqOptions Common to MySQL Cluster Programs\(rq\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --bind-address option (ndb_mgmd)
\fB\-\-bind\-address=\fR\fB\fIhost\fR\fR\fB[:\fR\fB\fIport\fR\fR\fB]\fR
.TS
allbox tab(:);
l l s
l l s
l l s
^ l l
^ l l.
T{
\fBVersion Introduced\fR
T}:T{
5\&.1\&.22\-ndb\-6\&.3\&.2
T}
T{
\fBCommand Line Format\fR
T}:T{
\-\-bind\-address
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
[none]
T}
.TE
.sp 1
When specified, this option limits management server connections by management clients to clients at the specified host name or IP address (and possibly port, if this is also specified)\&. In such cases, a management client attempting to connect to the management server from any other address fails with the error
Unable to setup port: \fIhost\fR:\fIport\fR!
.sp
If the
\fIport\fR
is not specified, the management client attempts to use port 1186\&.
.sp
This option was added in MySQL Cluster NDB 6\&.2\&.5 and MySQL Cluster NDB 6\&.3\&.2\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --configdir option (ndb_mgmd)
\fB\-\-configdir=\fR\fB\fIdirectory\fR\fR
.TS
allbox tab(:);
l l s
l l s
l l s
^ l l
^ l l.
T{
\fBVersion Introduced\fR
T}:T{
5\&.1\&.30\-ndb\-6\&.4\&.0
T}
T{
\fBCommand Line Format\fR
T}:T{
\-\-configdir=directory
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
filename
T}
:T{
\fBDefault\fR
T}:T{
$INSTALLDIR/mysql\-cluster
T}
.TE
.sp 1
Beginning with MySQL Cluster NDB 6\&.4\&.0, configuration data is cached internally rather than being read from the cluster global configuration file each time the management server is started (see
Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq)\&. This option instructs the management server to its configuration cache in the
\fIdirectory\fR
indicated\&. By default, this is a directory named
mysql\-cluster
in the MySQL installation directory \(em for example, if you compile and install MySQL Cluster on a Unix system using the default location, this is
/usr/local/mysql\-cluster\&.
.sp
This behavior can be overridden using the
\fB\-\-initial\fR
or
\fB\-\-reload\fR
option for
\fBndb_mgmd\fR\&. Each of these options is described elsewhere in this section\&.
.sp
This option is available beginning with MySQL Cluster NDB 6\&.4\&.0\&.
.sp
Beginning with MySQL Cluster NDB 7\&.0\&.8,
\fB\-\-config\-dir\fR
is accepted as an alias for
\fB\-\-configdir\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --config-file option (ndb_mgmd)
.\" -f option (ndb_mgmd)
.\" -c option (ndb_mgmd) (OBSOLETE)
\fB\-\-config\-file=\fR\fB\fIfilename\fR\fR,
\fB\-f \fR\fB\fIfilename\fR\fR
.TS
allbox tab(:);
l l s
l l s
^ l l
^ l l.
T{
\fBCommand Line Format\fR
T}:T{
\-c
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
filename
T}
:T{
\fBDefault\fR
T}:T{
\&./config\&.ini
T}
.TE
.sp 1
Instructs the management server as to which file it should use for its configuration file\&. By default, the management server looks for a file named
config\&.ini
in the same directory as the
\fBndb_mgmd\fR
executable; otherwise the file name and location must be specified explicitly\&.
.sp
Beginning with MySQL Cluster NDB 6\&.4\&.0, this option is ignored unless the management server is forced to read the configuration file, either because
\fBndb_mgmd\fR
was started with the
\fB\-\-reload\fR
or
\fB\-\-initial\fR
option, or because the management server could not find any configuration cache\&. See
Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq, for more information\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --daemon option (ndb_mgmd)
.\" -d option (ndb_mgmd)
\fB\-\-daemon\fR,
\fB\-d\fR
.TS
allbox tab(:);
l l s
l l s
^ l l
^ l l.
T{
\fBCommand Line Format\fR
T}:T{
\-\-daemon
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
TRUE
T}
.TE
.sp 1
Instructs
\fBndb_mgmd\fR
to start as a daemon process\&. This is the default behavior\&.
.sp
This option has no effect when running
\fBndb_mgmd\fR
on Windows platforms\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --initial option (ndb_mgmd)
\fB\-\-initial\fR
.TS
allbox tab(:);
l l s
l l s
l l s
^ l l
^ l l.
T{
\fBVersion Introduced\fR
T}:T{
5\&.1\&.30\-ndb\-6\&.4\&.0
T}
T{
\fBCommand Line Format\fR
T}:T{
\-\-initial
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Beginning with MySQL Cluster NDB 6\&.4\&.0, configuration data is cached internally rather than being read from the cluster global configuration file each time the management server is started (see
Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq)\&. Using this option overrides this behavior, by forcing the management server to delete any existing cache files, and then to re\-read the configuration data from the cluster configuration file and to build a new cache\&.
.sp
This differs in two ways from the
\fB\-\-reload\fR
option\&. First,
\fB\-\-reload\fR
forces the server to check the configuration file against the cache and reload its data only if the contents of the file are different from the cache\&. Second,
\fB\-\-reload\fR
does not delete any existing cache files\&.
.sp
If
\fBndb_mgmd\fR
is invoked with
\fB\-\-initial\fR
but cannot find a global configuration file, the management server cannot start\&.
.sp
This option was introduced in MySQL Cluster NDB 6\&.4\&.0\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --log-name option (ndb_mgmd)
\fB\-\-log\-name=\fR\fB\fIname\fR\fR
.TS
allbox tab(:);
l l s
l l s
l l s
^ l l
^ l l.
T{
\fBVersion Introduced\fR
T}:T{
5\&.1\&.37\-ndb\-7\&.0\&.8
T}
T{
\fBCommand Line Format\fR
T}:T{
\-\-log\-name=
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
MgmtSrvr
T}
.TE
.sp 1
Provides a name to be used for this node in the cluster log\&.
.sp
This option was added in MySQL Cluster NDB 7\&.0\&.8\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --nodaemon option (ndb_mgmd)
\fB\-\-nodaemon\fR
.TS
allbox tab(:);
l l s
l l s
^ l l
^ l l.
T{
\fBCommand Line Format\fR
T}:T{
\-\-nodaemon
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Instructs
\fBndb_mgmd\fR
not to start as a daemon process\&.
.sp
As of MySQL Cluster NDB 7\&.0\&.8, the default behavior for
\fBndb_mgmd\fR
on Windows is to run in the foreground, making this option unnecessary on Windows platforms\&. (\m[blue]\fBBug#45588\fR\m[]\&\s-2\u[1]\d\s+2)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --print-full-config option (ndb_mgmd)
.\" -P option (ndb_mgmd)
\fB\-\-print\-full\-config\fR,
\fB\-P\fR
.TS
allbox tab(:);
l l s
l l s
^ l l
^ l l.
T{
\fBCommand Line Format\fR
T}:T{
\-\-print\-full\-config
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Shows extended information regarding the configuration of the cluster\&. With this option on the command line the
\fBndb_mgmd\fR
process prints information about the cluster setup including an extensive list of the cluster configuration sections as well as parameters and their values\&. Normally used together with the
\fB\-\-config\-file\fR
(\fB\-f\fR) option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" --reload option (ndb_mgmd)
\fB\-\-reload\fR
.TS
allbox tab(:);
l l s
l l s
l l s
^ l l
^ l l.
T{
\fBVersion Introduced\fR
T}:T{
5\&.1\&.30\-ndb\-6\&.4\&.0
T}
T{
\fBCommand Line Format\fR
T}:T{
\-\-reload
T}
T{
\ \&
T}:T{
\fBPermitted Values \fR
T}
:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
FALSE
T}
.TE
.sp 1
Beginning with MySQL Cluster NDB 6\&.4\&.0, configuration data is stored internally rather than being read from the cluster global configuration file each time the management server is started (see
Section\ \&17.3.2, \(lqMySQL Cluster Configuration Files\(rq)\&. Using this option forces the management server to check its internal data store against the cluster configuration file and to reload the configuration if it finds that the configuration file does not match the cache\&. Existing configuration cache files are preserved, but not used\&.
.sp
This differs in two ways from the
\fB\-\-initial\fR
option\&. First,
\fB\-\-initial\fR
causes all cache files to be deleted\&. Second,
\fB\-\-initial\fR
forces the management server to re\-read the global configuration file and construct a new cache\&.
.sp
If the management server cannot find a global configuration file, then the
\fB\-\-reload\fR
option is ignored\&.
.sp
This option was introduced in MySQL Cluster NDB 6\&.4\&.0\&.
.RE
.PP
It is not strictly necessary to specify a connectstring when starting the management server\&. However, if you are using more than one management server, a connectstring should be provided and each node in the cluster should specify its node ID explicitly\&.
.PP
See
Section\ \&17.3.2.3, \(lqThe MySQL Cluster Connectstring\(rq, for information about using connectstrings\&.
\fBndb_mgmd\fR(8), describes other options for
\fBndb_mgmd\fR\&.
.PP
The following files are created or used by
\fBndb_mgmd\fR
in its starting directory, and are placed in the
DataDir
as specified in the
config\&.ini
configuration file\&. In the list that follows,
\fInode_id\fR
is the unique node identifier\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" MySQL Cluster: configuration
.\" configuring MySQL Cluster
.\" config.ini (MySQL Cluster)
config\&.ini
is the configuration file for the cluster as a whole\&. This file is created by the user and read by the management server\&.
Section\ \&17.3, \(lqMySQL Cluster Configuration\(rq, discusses how to set up this file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ndb_\fInode_id\fR_cluster\&.log
is the cluster events log file\&. Examples of such events include checkpoint startup and completion, node startup events, node failures, and levels of memory usage\&. A complete listing of cluster events with descriptions may be found in
Section\ \&17.5, \(lqManagement of MySQL Cluster\(rq\&.
.sp
When the size of the cluster log reaches one million bytes, the file is renamed to
ndb_\fInode_id\fR_cluster\&.log\&.\fIseq_id\fR, where
\fIseq_id\fR
is the sequence number of the cluster log file\&. (For example: If files with the sequence numbers 1, 2, and 3 already exist, the next log file is named using the number
4\&.)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ndb_\fInode_id\fR_out\&.log
is the file used for
stdout
and
stderr
when running the management server as a daemon\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ndb_\fInode_id\fR\&.pid
is the process ID file used when running the management server as a daemon\&.
.RE
.SH "COPYRIGHT"
.br
.PP
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
.SH "NOTES"
.IP " 1." 4
Bug#45588
.RS 4
\%http://bugs.mysql.com/45588
.RE
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
Sun Microsystems, Inc. (http://www.mysql.com/).
